/*
 * Copyright (c) 2008-2016 Haulmont.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.haulmont.cuba.core.global;

import java.time.ZonedDateTime;
import java.util.Date;

/**
 * Global time source interface. Must be used everywhere instead of <code>new Date()</code> and
 * <code>System.currentTimeMillis()</code>
 *
 */
public interface TimeSource {

    String NAME = "cuba_TimeSource";

    /**
     * Return current timestamp as Date instance.
     * @return  current timestamp
     */
    Date currentTimestamp();

    /**
     * Return current timestamp in milliseconds.
     * @return  number of milliseconds since 1970-01-01 00:00
     */
    long currentTimeMillis();

    /**
     * Return {@code ZonedDateTime} for current timestamp.
     * @return  ZonedDateTime
     */
    ZonedDateTime now();
}
